ORS Android Client/org.nitri.ors.domain.optimization

Package-level declarations

Types

Amount

typealias Amount = List<Int>

ComputingTimes

@Serializable

data class ComputingTimes(val loading: Int? = null, val solving: Int? = null, val routing: Int? = null)

CustomMatrix

@Serializable

data class CustomMatrix(val durations: List<List<Int>>? = null, val distances: List<List<Int>>? = null)

Job

@Serializable

data class Job(val id: Int, val service: Int? = null, val delivery: Amount? = null, val pickup: Amount? = null, val amount: Amount? = null, val location: LonLat? = null, val locationIndex: Int? = null, val allowedVehicles: List<Int>? = null, val disallowedVehicles: List<Int>? = null, val skills: Skills? = null, val priority: Int? = null, val timeWindows: List<TimeWindow>? = null)

LonLat

typealias LonLat = List<Double>

OptimizationRequest

@Serializable

data class OptimizationRequest(val jobs: List<Job>? = null, val shipments: List<Shipment>? = null, val vehicles: List<Vehicle>, val matrices: Map<String, CustomMatrix>? = null, val options: Map<String, JsonElement>? = null)

Root payload sent to /optimization See: https://github.com/VROOM-Project/vroom/blob/master/docs/API.md

OptimizationRequestBuilder

class OptimizationRequestBuilder

Builder used by optimizationRequest.

OptimizationRequestBuilderJ

class OptimizationRequestBuilderJ

Java-friendly builder counterpart.

OptimizationResponse

@Serializable

data class OptimizationResponse(val code: Int, val summary: OptimizationSummary, val unassigned: List<Unassigned> = emptyList(), val routes: List<OptimizedRoute> = emptyList())

Top-level result from /optimization

OptimizationSummary

@Serializable

data class OptimizationSummary(val cost: Int, val routes: Int, val unassigned: Int, val delivery: List<Int>? = null, val amount: List<Int>? = null, val pickup: List<Int>? = null, val setup: Int, val service: Int, val duration: Int, val waitingTime: Int, val priority: Int, val violations: List<Violation> = emptyList(), val computingTimes: ComputingTimes? = null)

OptimizedRoute

@Serializable

data class OptimizedRoute(val vehicle: Int, val cost: Int, val delivery: List<Int>? = null, val amount: List<Int>? = null, val pickup: List<Int>? = null, val setup: Int, val service: Int, val duration: Int, val waitingTime: Int, val priority: Int, val steps: List<RouteStep> = emptyList(), val violations: List<Violation> = emptyList())

RouteStep

@Serializable

data class RouteStep(val type: String, val location: LonLat, val id: Int? = null, val job: Int? = null, val setup: Int? = null, val service: Int? = null, val waitingTime: Int? = null, val load: List<Int>? = null, val arrival: Int? = null, val duration: Int? = null, val violations: List<Violation> = emptyList())

Shipment

@Serializable

data class Shipment(val id: Int, val amount: Amount? = null, val pickup: ShipmentStep, val delivery: ShipmentStep, val skills: Skills? = null, val priority: Int? = null)

ShipmentStep

@Serializable

data class ShipmentStep(val service: Int? = null, val location: LonLat? = null, val locationIndex: Int? = null, val timeWindows: List<TimeWindow>? = null)

Skills

typealias Skills = List<Int>

TimeWindow

@Serializable

data class TimeWindow(val start: Int, val end: Int)

Unassigned

@Serializable

data class Unassigned(val id: Int, val location: LonLat, val type: String)

Vehicle

@Serializable

data class Vehicle(val id: Int, val profile: String, val capacity: Amount? = null, val start: LonLat? = null, val end: LonLat? = null, val startIndex: Int? = null, val endIndex: Int? = null, val skills: Skills? = null, val timeWindow: TimeWindow? = null, val breaks: List<VehicleBreak>? = null, val earliestStart: Int? = null, val latestEnd: Int? = null, val maxTasks: Int? = null, val maxTravelTime: Int? = null, val description: String? = null)

VehicleBreak

@Serializable

data class VehicleBreak(val service: Int? = null, val timeWindows: List<TimeWindow>)

Violation

@Serializable

data class Violation(val type: String? = null, val id: Int? = null, val job: Int? = null, val description: String? = null)

Kept flexible; VROOM may return several shapes depending on constraint hit.

Functions

optimizationRequest

inline fun optimizationRequest(build: OptimizationRequestBuilder.() -> Unit): OptimizationRequest

DSL for building OptimizationRequest payloads.